# {{classname}}{{#description}}
{{.}}{{/description}}

All URIs are relative to *{{basePath}}*

Method | HTTP request | Description
------------- | ------------- | -------------
{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{summary}}
{{/operation}}{{/operations}}

{{#operations}}
{{#operation}}
# **{{{operationId}}}**
> `{{operationId}}`(_api::`{{classname}}`{{#allParams}}{{#required}}, `{{paramName}}`::`{{dataType}}`{{/required}}{{/allParams}};{{#allParams}}{{^required}} `{{paramName}}`=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> {{#returnType}}`{{{.}}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}, `OpenAPI.Clients.ApiResponse` <br/>
> `{{operationId}}`(_api::`{{classname}}`, response_stream::`Channel`{{#allParams}}{{#required}}, `{{paramName}}`::`{{dataType}}`{{/required}}{{/allParams}};{{#allParams}}{{^required}} `{{paramName}}`=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> `Channel`{ {{#returnType}}`{{{.}}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}} }, `OpenAPI.Clients.ApiResponse`

{{{summary}}}{{#notes}}

{{{.}}}{{/notes}}

### Required Parameters
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **_api** | **`{{classname}}`** | API context | {{/-last}}{{/allParams}}{{#allParams}}{{#required}}
**`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}} | {{description}} |{{/required}}{{/allParams}}{{#hasOptionalParams}}

### Optional Parameters
{{#allParams}}{{#-last}}
Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}}{{^required}}
 **`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^isBinary}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}}{{/isBinary}}{{/required}}{{/allParams}}{{/hasOptionalParams}}

### Return type

{{#returnType}}{{#returnTypeIsPrimitive}}**`{{{returnType}}}`**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**`{{{returnType}}}`**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}

### Authorization

{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}}

### HTTP request headers

 - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
 - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

{{/operation}}
{{/operations}}
